레젠위키
로그인

레젠위키

the tree

문서 마지막 편집
the tree
정식 명칭
the tree
개발
hyonsu (GitHub: wjdgustn)
유형
위키 엔진
기반
Node.js
DB
MongoDB
검색
Meilisearch
프론트엔드
thetree-frontend(스킨 빌드 방식)
데모
공식 저장소

1. 개요2. 특징
2.1. 나무마크 호환2.2. 스킨(프론트엔드) 빌드 구조2.3. 플러그인/확장2.4. 개발자 지원 기능(dev support)
3. 요구 사항4. 설치
4.1. 일반 설치4.2. Docker 설치
5. 라이선스6. 관련 프로젝트7. 외부 링크


1. 개요 [편집]

the tree는 나무마크 호환을 지향하는 위키 엔진이다. the seed 엔진의 시스템을 참고하여 구현되었으며, 완전 동일한 구현을 목표로 하지는 않는다고 안내되어 있다.

2. 특징 [편집]

2.1. 나무마크 호환 [편집]

나무마크 기반 문법을 지원하는 것을 목표로 한다.

2.2. 스킨(프론트엔드) 빌드 구조 [편집]

엔진과 별도로 thetree-frontend 레포지토리를 통해 스킨을 빌드하여 적용하는 구조를 사용한다. 스킨 제작 가이드를 참고하여 자유롭게 스킨을 제작할 수 있다고 안내되어 있다.

2.3. 플러그인/확장 [편집]

매크로 추가 등 플러그인 기능에 대해 언급되어 있으며, 엔진 수정이 필요한 경우 별도 협의를 요청하도록 안내되어 있다.

2.4. 개발자 지원 기능(dev support) [편집]

엔진에 개발자(엔진 제작자)의 위키 소유자 권한 접근을 허용하는 기능이 내장되어 있다고 안내되어 있으며, 관련 동작은 감사 로그에 기록된다고 한다. 필요 시 devConfig.json의 disable_dev_support 값을 true로 설정하여 비활성화할 수 있다고 안내되어 있다.

3. 요구 사항 [편집]

* Node.js
* MongoDB
* Meilisearch
* (스킨 적용을 위한) thetree-frontend

4. 설치 [편집]

4.1. 일반 설치 [편집]

1. git clone으로 엔진을 다운로드한다.
2. .env.example을 .env로 복사 후 값을 채운다.
3. *.example.json을 *.json으로 복사 후 값을 채운다.
4. npm i로 의존성을 설치한다.
5. thetree-frontend의 스킨 적용 가이드를 따라 스킨을 빌드한다.
6. pm2 등 프로세스 매니저로 main.js를 실행한다.
7. 첫 가입자는 자동으로 소유자 권한을 부여받으며, 초기 설정 페이지로 이동한다. (탭을 닫은 경우 /admin/initial_setup)

4.2. Docker 설치 [편집]

레포지토리에서 제공하는 compose 템플릿(compose-full.yaml 또는 compose-min.yaml)을 수정하여 구동한다.
구동 후 /member/signup에서 가입하고 /admin/initial_setup에서 초기 설정을 진행한다.

5. 라이선스 [편집]

the tree는 오픈소스 라이선스를 적용하지 않는다고 안내되어 있다.
엔진을 위키 구동에 사용하는 것은 허가되나, 엔진 수정 및 재배포는 금지된다고 안내되어 있다.

6. 관련 프로젝트 [편집]

* thetree-frontend: the tree 엔진용 프론트엔드/스킨 빌드 레포지토리
* thetree-monaco: Monaco Editor 플러그인

7. 외부 링크 [편집]